# HITORI

## Demo video link
https://drive.google.com/file/d/1QUe5SVWxEW2Gm1pmwzM-1oJhdV8F0iTU/view?usp=share_link

## Documentation

- Read the pdf.

## Usage

- Prerequisites:
  + 64bit architecture;
  + scons (ideally installed via Python and pip);
  + Godot Engine v3.5.1.
- Usage guide:
  + Clone the gdnative repository to a folder godot-cpp.
  + Place this hitori folder on the same level as godot-cpp. If you set up gdnative in a different location, please edit the SConstruct file on the same level as this markdown file correspondingly.
  + Go to ``HitoriGenerator/cpp``, run ``scons platform=<your_platform> target=release`` in terminal at this directory, a static library should be created in ``bin/``. You can use this static library for any purposes.
  + To build the Godot game, return to the main directory, run ``scons platform=<your_platform> target=release`` from terminal (must be the same as the previous command), NativeLib.dll should be created in ``Godot/bin/``.
  + Open ``Godot/project.godot`` with Godot Engine.
  + NativeLib.tres has been set up for windows 64bit applications, adjust for your operating system.
  + Export the project to a target platform, following normal GDNative instructions.
  
---

## License

- The kurland font files (``Godot\font\kurland.otf`` and ``Godot\font\kurland.ttf``) are licensed under the SIL Open Font License, Version 1.1. A copy of this license is located at ``Godot\font\License.txt``;
- Audio files are all public domain under CC0, downloaded from freesound.org.

---

- As for the remaining files, to the extent possible under law, the person who associated CC0 with *hitori* has waived all copyright and related or neighboring rights to *hitori*.
- You should have received a copy of the CC0 legalcode along with this work.  If not, see <http://creativecommons.org/publicdomain/zero/1.0/> .
